GET All Select Options for Channels

Overview

---

The table below provides key details about the GET method for retrieving all selected options for channels.

Get All Select Options for Channels
Method	GET
URL or Endpoint	/api/v1/projectId/channels/options
Headers	Authorization
Parameters	projectId

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

The request does not have a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "types": [
      {
        "typeId": 1,
        "name": "Standard"
      },
      {
        "typeId": 2,
        "name": "SlowTV"
      }
    ],
    "latencyTypes": [
      {
        "latencyTypeId": 1,
        "name": "Normal"
      },
      {
        "latencyTypeId": 2,
        "name": "Low"
      },
      {
        "latencyTypeId": 3,
        "name": "UltraLow"
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
types	array[Object]	Returns an array with available types that are used to create a channel
typeId	integer($int32)	Indicates the unique identifier assigned to each type
name	string	Indicates the descriptive name of the type
latencyTypes	array	Returns an array with available latency types that are used to create a channel
latencyTypeId	integer($int32)	Indicates the unique identifier assigned to each latency type
name	string	Returns the name associated with each latency type
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed